如何贡献文档

    BFE的文档主要分为以下几个类别：

    • 快速入门：旨在帮助用户快速安装和入门；

    • 使用指南：旨在为用户提BFE基本用法讲解；

    • 开发指南：旨在满足开发者的需求；

    我们的文档支持Markdown (GitHub风格)格式的内容贡献。

    在此之前，请确认您的操作系统安装了gitbook及依赖项

    以ubuntu系统为例，运行：

    Clone仓库

    下载完整的BFE仓库：

    进入您希望加载和构建内容的目录列表（docs/LANG）, 运行：

    然后：打开浏览器并导航到

    所有内容都应该以 (GitHub风格)的形式编写。

    贡献编写文档

    • 创建一个新的 文件或在您当前操作的仓库中修改已存在的文章
    • 在文档基目录(docs/LANG)启动预览工具

    预览修改

    打开浏览器并导航到

    在要更新的页面上，单击右上角的Refresh Content

    修改文档, 提交修改与PR的步骤可以参考

    我们非常欢迎您对平台和支持内容的各个方面做出贡献，以便更好地呈现这些内容。您可以Fork或Clone这个存储库，或者提出问题并提供反馈，以及在issues上提交bug信息。详细内容请参考。